<!DOCTYPE html>
<html>
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
    <title>scan</title>
    <link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
    <script>var pathToRoot = "../../../";</script>
    <script>const storage = localStorage.getItem("dokka-dark-mode")
    if (storage == null) {
        const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
        if (osDarkSchemePreferred === true) {
            document.getElementsByTagName("html")[0].classList.add("theme-dark")
        }
    } else {
        const savedDarkMode = JSON.parse(storage)
        if(savedDarkMode === true) {
            document.getElementsByTagName("html")[0].classList.add("theme-dark")
        }
    }
    </script>
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../styles/style.css" rel="Stylesheet">
<link href="../../../styles/jetbrains-mono.css" rel="Stylesheet">
<link href="../../../styles/main.css" rel="Stylesheet">
<link href="../../../styles/prism.css" rel="Stylesheet">
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
    <div id="leftToggler"><span class="icon-toggler"></span></div>
    <div class="library-name">
            <a href="../../../index.html">
                    <span>libraryCore</span>
            </a>
    </div>
    <div>
    </div>
    <div class="pull-right d-flex">
        <div class="filter-section" id="filter-section">
                <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":libraryCore:dokkaHtml/release">androidJvm</button>
        </div>
        <button id="theme-toggle-button"><span id="theme-toggle"></span></button>
        <div id="searchBar"></div>
    </div>
</div>
<div id="container">
    <div id="leftColumn">
        <div id="sideMenu"></div>
    </div>
    <div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="libraryCore::com.topstep.fitcloud.sdk.scanner/FcScanner/scan/#kotlin.Long#java.util.concurrent.TimeUnit#kotlin.Boolean#kotlin.Boolean/PointingToDeclaration//106218074">
  <div class="breadcrumbs"><a href="../../../index.html">libraryCore</a><span class="delimiter">/</span><a href="../index.html">com.topstep.fitcloud.sdk.scanner</a><span class="delimiter">/</span><a href="index.html">FcScanner</a><span class="delimiter">/</span><span class="current">scan</span></div>
  <div class="cover ">
    <h1 class="cover"><span><span>scan</span></span></h1>
  </div>
  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":libraryCore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="scan.html"><span class="token function">scan</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">time<span class="token operator">: </span><span data-unresolved-link="kotlin/Long///PointingToDeclaration/">Long</span><span class="token punctuation">, </span></span><span class="parameter ">unit<span class="token operator">: </span><span data-unresolved-link="java.util.concurrent/TimeUnit///PointingToDeclaration/">TimeUnit</span><span class="token punctuation">, </span></span><span class="parameter ">checkLocationServiceFirst<span class="token operator">: </span><span data-unresolved-link="kotlin/Boolean///PointingToDeclaration/">Boolean</span><span class="token punctuation">, </span></span><span class="parameter ">acceptEmptyDeviceName<span class="token operator">: </span><span data-unresolved-link="kotlin/Boolean///PointingToDeclaration/">Boolean</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="io.reactivex.rxjava3.core/Observable///PointingToDeclaration/">Observable</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-fc-scan-result/index.html">FcScanResult</a><span class="token operator">&gt;</span></div><p class="paragraph">Scan and filter to emit only &quot;FitCloud&quot; devices.</p><p class="paragraph">On Android 6.0 and above, it is recommended to enable location services before scan. See also:https://issuetracker.google.com/issues/37065090.</p><p class="paragraph">But this is not necessarily required. Some mobile phones can scan the device even when the location is disabled. So you can use <a href="scan.html">checkLocationServiceFirst</a> to decide whether to check the location service first.</p><p class="paragraph">If <a href="scan.html">checkLocationServiceFirst</a> is true, when the location service is disabled, <span data-unresolved-link="com.polidea.rxandroidble3.exceptions/BleScanException/LOCATION_SERVICES_DISABLED/#/PointingToDeclaration/">BleScanException.LOCATION_SERVICES_DISABLED</span> will be thrown directly before the scan.</p><p class="paragraph">If <a href="scan.html">checkLocationServiceFirst</a> is false, if none of the devices (not only &quot;FitCloud&quot; devices) are scanned within the specified time, This method will detect whether location service is enabled when it is completed, and optionally throw <span data-unresolved-link="com.polidea.rxandroidble3.exceptions/BleScanException/LOCATION_SERVICES_DISABLED/#/PointingToDeclaration/">BleScanException.LOCATION_SERVICES_DISABLED</span> based on the previous scan environment. This may not be accurate, but it's the only thing the SDK can do.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":libraryCore:dokkaHtml/release" data-filterable-set=":libraryCore:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>time</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Scan duration time</p></div></div></div></div><div class="table-row" data-filterable-current=":libraryCore:dokkaHtml/release" data-filterable-set=":libraryCore:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>unit</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Scan duration time unit</p></div></div></div></div><div class="table-row" data-filterable-current=":libraryCore:dokkaHtml/release" data-filterable-set=":libraryCore:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>check</span><wbr></wbr><span>Location</span><wbr></wbr><span>Service</span><wbr></wbr><span><span>First</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Whether to check location services is enabled before scan.</p></div></div></div></div><div class="table-row" data-filterable-current=":libraryCore:dokkaHtml/release" data-filterable-set=":libraryCore:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>accept</span><wbr></wbr><span>Empty</span><wbr></wbr><span>Device</span><wbr></wbr><span><span>Name</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Whether to accept results with an empty device name</p></div></div></div></div></div><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":libraryCore:dokkaHtml/release" data-filterable-set=":libraryCore:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><span data-unresolved-link="com.polidea.rxandroidble3.exceptions/BleScanException///PointingToDeclaration/"><span>Ble</span><wbr></wbr><span>Scan</span><wbr></wbr><span><span>Exception</span></span></span></div></span></div><div></div></div></div></div></div></div>
</div>
      <div class="footer">
        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
                class="pull-right"><span>Generated by </span><a
                href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
      </div>
    </div>
</div>
</body>
</html>
